Skip to content

Enable codespell#118

Merged
kydos merged 2 commits intozenoh-rs:masterfrom
fujitatomoya:enable-codespell
Feb 2, 2026
Merged

Enable codespell#118
kydos merged 2 commits intozenoh-rs:masterfrom
fujitatomoya:enable-codespell

Conversation

@fujitatomoya
Copy link
Contributor

This PR has 2 major things.

  • Enabling codespell github workflow to keep the documentation quality. This confirms that every PR spelling check needs to be on green light before merge.
  • Bunch of misspelling fixes. (just a minor cosmetic changes detected by codespell)

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
@fujitatomoya
Copy link
Contributor Author

spellcheck workflow is now green to go merge. (if developer adds the misspell or typos, this workflow can tell where and how to fix.)

Copy link
Contributor Author

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JEnoch minor enhancement for CI/CD documentation quality, can you take a look when you have time?

Comment on lines +12 to +13
# Skip checking files in this directory.
skip = ./public/*,./resources/*,./static/*
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only focus on documentation contents to avoid the false positive.

Comment on lines +6 to +7
# Ignore words listed in this file.
ignore-words = codespell_whitelist.txt
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if there are any specific words to ignore for codespell such as zenoh specific words, we can add them in here to skip.

Comment on lines +9 to +10
# Add custom dictionary file.
dictionary = codespell_dictionary.txt,-
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is NOT used yet, but useful to catch the zenoh specific wording if there are.

@fujitatomoya
Copy link
Contributor Author

@sashacmc @JEnoch friendly ping!

@kydos
Copy link
Contributor

kydos commented Feb 2, 2026

@fujitatomoya thank you very much for the contribution. Merging it!

@kydos kydos closed this Feb 2, 2026
@kydos kydos reopened this Feb 2, 2026
@kydos kydos merged commit 0e43fa5 into zenoh-rs:master Feb 2, 2026
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants